/*
 * @(#) $Header$
 *
 * Copyright (C) 2007  Forklabs Daniel Léonard
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

package ca.forklabs.media.jai.opimage;

import java.awt.RenderingHints;
import java.awt.image.renderable.ContextualRenderedImageFactory;
import javax.media.jai.CRIFImpl;
import javax.media.jai.ImageLayout;
import javax.media.jai.JAI;

/**
 * Class {@code AbstractCRIF} provides common code for implementations of
 * {@link ContextualRenderedImageFactory}.
 *
 * @author   <a href="mailto:forklabs at gmail.com?subject=ca.forklabs.media.jai.opimage.AbstractCRIF">Daniel Léonard</a>
 * @version $Revision$
 */
public abstract class AbstractCRIF extends CRIFImpl {

//---------------------------
// Constructor
//---------------------------

   /**
    * Constructor.
    * @param   name   the name of the operation.
    */
   protected AbstractCRIF(String name) {
      super(name);
      }


//---------------------------
// Abstract methods
//---------------------------

   /**
    * Gets the image layout from the given rendering hints.
    * @param   hints   the rendering hints.
    * @return   the image layout.
    */
   protected ImageLayout getImageLayout(RenderingHints hints) {
      ImageLayout image_layout = (null == hints) ? null : (ImageLayout) hints.get(JAI.KEY_IMAGE_LAYOUT);
      return image_layout;
      }

   }
